util.format list issue #1099
Merged
util.format list issue #1099
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdonnalley
reviewed
Jul 9, 2024
| // This causes the token to be appended to each line regardless of the presence of a specifier. | ||
| // Here we check for the presence of a specifier and only format the message if one is present. | ||
| // https://nodejs.org/api/util.html#utilformatformat-args | ||
| // https://regex101.com/r/8Hf8Z6/1 |
There was a problem hiding this comment.
Having a link to the regex is brilliant 🏆
mdonnalley
previously approved these changes
Jul 9, 2024
|
QA 🟢 tokenized input only occurs once in markdown list with single |
|
Here is an example console.logging a pseudo telem event (ignore the Error, it is unrelated) |
This was referenced Sep 24, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Note
We decided to postpone this change to collect information via telemetry. Once all missing specifiers have been corrected, we will enforce them. Follow up work will be completed in @W-16197665@
Caution
This is technically a breaking change. If we have a message somewhere that is missing a specifier, the tokens will no longer be rendered. This is a difficult thing to validate across our codebase. We could do a few things:
sfdx-coremessageshas a length greater than1This is a solution to prevent tokens from being rendered in a message when a specifier (e.g.
%s) does not existIf the message does not contain a specifier, node's
util.formatstill appends the token to the end (docs)This issue was discovered in
sf whatsnew --helpwhere the token for the specifier%swas being rendered at the end of each example. This was happening because themarkdownLoaderautomatically splits bulleted lists into arrays.We now check for the presence of a specifier and only format the message if one is present.
BEFORE:
AFTER:
Testing
yarn buildyarn linkcdto plugin-infoyarn link @salesforce/corebin/run.js whatsnew --helpWhat issues does this PR fix or reference?
@W-16188160@